﻿/******************************************************************************************************
Copyright (c) 2014 Steven Giacomelli (stevegiacomelli@gmail.com)

Permission is hereby granted, free of charge, to any person obtaining a copy of this
software and associated documentation files (the "Software"), to deal in the Software
without restriction, including without limitation the rights to use, copy, modify,
merge, publish, distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies
or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
******************************************************************************************************/

using System.Collections.ObjectModel;

namespace SharpGeo.Indexing
{
    /// <summary>
    /// The superclass for all spatial indexes
    /// </summary>
    /// <typeparam name="T">The type to store</typeparam>
    public abstract class SpatialIndex<T> where T : Geometry
    {
        #region Constructor

        /// <summary>
        /// Constructs a SpatialIndex
        /// </summary>
        protected SpatialIndex()
        {
        }

        #endregion Constructor

        /// <summary>
        /// Gets the number of stored Geometry objects
        /// </summary>
        public int Count { get; protected set; }

        /// <summary>
        /// Returns the Envelope (axis aligned bounding box) of this R-Tree
        /// </summary>
        public abstract Envelope Envelope { get; }
        /// <summary>
        /// Gets the ReadOnly state of this Spatial Index
        /// </summary>
        public virtual bool IsReadOnly { get { return false; } }

        /// <summary>
        /// Queries the spatial index for all objects that intersect with the searchEnvelope
        /// </summary>
        /// <param name="searchEnvelope">The envelope to test for intersection with</param>
        /// <returns>A list of objects intersecting the searchEnvelope</returns>
        public abstract ReadOnlyCollection<T> QueryIntersection(Envelope searchEnvelope);
    }
}